// $Id: fontlist.h 1282 2006-06-09 09:46:49Z alex $
/* @@tag:xara-cn@@ DO NOT MODIFY THIS LINE
================================XARAHEADERSTART===========================
 
               Xara LX, a vector drawing and manipulation program.
                    Copyright (C) 1993-2006 Xara Group Ltd.
       Copyright on certain contributions may be held in joint with their
              respective authors. See AUTHORS file for details.

LICENSE TO USE AND MODIFY SOFTWARE
----------------------------------

This file is part of Xara LX.

Xara LX is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License version 2 as published
by the Free Software Foundation.

Xara LX and its component source files are distributed in the hope
that it will be useful, but WITHOUT ANY WARRANTY; without even the
implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along
with Xara LX (see the file GPL in the root directory of the
distribution); if not, write to the Free Software Foundation, Inc., 51
Franklin St, Fifth Floor, Boston, MA  02110-1301 USA


ADDITIONAL RIGHTS
-----------------

Conditional upon your continuing compliance with the GNU General Public
License described above, Xara Group Ltd grants to you certain additional
rights. 

The additional rights are to use, modify, and distribute the software
together with the wxWidgets library, the wxXtra library, and the "CDraw"
library and any other such library that any version of Xara LX relased
by Xara Group Ltd requires in order to compile and execute, including
the static linking of that library to XaraLX. In the case of the
"CDraw" library, you may satisfy obligation under the GNU General Public
License to provide source code by providing a binary copy of the library
concerned and a copy of the license accompanying it.

Nothing in this section restricts any of the rights you have under
the GNU General Public License.


SCOPE OF LICENSE
----------------

This license applies to this program (XaraLX) and its constituent source
files only, and does not necessarily apply to other Xara products which may
in part share the same code base, and are subject to their own licensing
terms.

This license does not apply to files in the wxXtra directory, which
are built into a separate library, and are subject to the wxWindows
license contained within that directory in the file "WXXTRA-LICENSE".

This license does not apply to the binary libraries (if any) within
the "libs" directory, which are subject to a separate license contained
within that directory in the file "LIBS-LICENSE".


ARRANGEMENTS FOR CONTRIBUTION OF MODIFICATIONS
----------------------------------------------

Subject to the terms of the GNU Public License (see above), you are
free to do whatever you like with your modifications. However, you may
(at your option) wish contribute them to Xara's source tree. You can
find details of how to do this at:
  http://www.xaraxtreme.org/developers/

Prior to contributing your modifications, you will need to complete our
contributor agreement. This can be found at:
  http://www.xaraxtreme.org/developers/contribute/

Please note that Xara will not accept modifications which modify any of
the text between the start and end of this header (marked
XARAHEADERSTART and XARAHEADEREND).


MARKS
-----

Xara, Xara LX, Xara X, Xara X/Xtreme, Xara Xtreme, the Xtreme and Xara
designs are registered or unregistered trademarks, design-marks, and/or
service marks of Xara Group Ltd. All rights in these marks are reserved.


      Xara Group Ltd, Gaddesden Place, Hemel Hempstead, HP2 6EX, UK.
                        http://www.xara.com/

=================================XARAHEADEREND============================
 */

// The header file for class descriptions of the font usage list.
           
/*
*/

#ifndef INC_FONTLIST
#define INC_FONTLIST

//#include "listitem.h" - in camtypes.h [AUTOMATICALLY REMOVED]
//#include "list.h" - in camtypes.h [AUTOMATICALLY REMOVED]
#include "attrmap.h"
//#include "fontbase.h"

class Document;
class Node;

/***********************************************************************************************

>	class FontListItem: public ListItem

	Author:		Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com>
	Created:	20/4/95
	Purpose:	A class to describe the structure of an item held in the font usage list.
				An item simply contains a fontname and a usage count

***********************************************************************************************/

class FontListItem: public ListItem
{
	CC_DECLARE_MEMDUMP(FontListItem);

public:
	FontListItem();

	void		Initialise(String_64& String, INT32 Style, FontClass = FC_UNDEFINED);
	void		IncUsage() { FontUsage++; }

	String_64	GetFontName() { return FontName; }
	INT32		GetFontStyle() { return	FontStyle; }
	INT32		GetFontUsage() { return	FontUsage; }
	FontClass	GetFontClass() { return	Class; }

private:
	String_64	FontName;
	INT32		FontStyle;
	INT32		FontUsage;
	FontClass	Class;
};


/***********************************************************************************************

>	class FontList : public CC_CLASS_MEMDUMP

	Author:		Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com>
	Created:	5/12/94
	Purpose:	A class which can be used to create a font usage list. Create an instance of
				this class and pass its Build() function a particular document pointer. The
				function will create a list of used fonts in that particular document, each
				item of which will contain a font name and usage count

***********************************************************************************************/

class FontList : public CC_CLASS_MEMDUMP
{
	CC_DECLARE_MEMDUMP(FontList);

public:
	 FontList();
	~FontList();

	BOOL 			Build(Document* pDoc);
	BOOL			AddItem(FontListItem* pFontListObj);
	FontListItem*	GetFirstItem();
	FontListItem*	GetNextItem(FontListItem* pCurrItem);
	FontListItem*	FindFontMatch(const String_64& FName, INT32 style, FontClass Class = FC_UNDEFINED);

private:
	BOOL 			EnumerateItems(Node* pNode);

private:
	List			TheFontList;
	CCAttrMap		AppliedAtts;
};


#endif
